Updates to README #453
Updates to README #453
Conversation
| In the future, MSRV changes will be accompanied by a minor version bump. | ||
| | Releases | Public API Component(s) | Policy | | ||
| | :--- | :--- | :--- | | ||
| | 4.x | Dependencies `digest` and `rand_core` | Minor SemVer bump | | ||
|
|
There was a problem hiding this comment.
I removed the line here about removing exemptions in the future. It wasn't saying much and we don't need to make those promises now imo.
README.md
Outdated
| ## Major Version API Changes | ||
|
|
||
| See `CHANGELOG.md` for more details. | ||
| See [`CHANGELOG.md`](CHANGELOG.md) for more details. | ||
|
|
||
| ### 2.x |
There was a problem hiding this comment.
I would mayhaps move these to CHANGELOG.md and mayhaps mark breaking public API changes some way e.g. Breaking Changes: there
There was a problem hiding this comment.
I kinda of agree that it feels cluttered here, but CHANGELOG.md has a list of all the versions. So to keep it consistent, the API-breaking changes would have to go just in the x.0.0 headers. But that makes it hard to skim. Did you have something in mind?
There was a problem hiding this comment.
Ctrl-F "Breaking Changes" ? 😅
Ideally they probably mayhaps be in Release notes in GitHub and then link to release notes - which in turn get generated from CHANGELOG.md automatically upon release - that could be linked instead ?
Could also link by to CHANGELOG.md with # anchor points ?
There isn't too many with 2.x anymore and the ones at 2.x are unmaintained anyways me thinks ?
https://crates.io/crates/curve25519-dalek/reverse_dependencies
There was a problem hiding this comment.
I split the difference a bit here. I left the 4.x breaking changes in the README so people can see it at a glance. The rest is now in the CHANGELOG under "Breaking changes"
As suggested in #453 it is sometimes feasible to select the backend bits via an override. This change provides `cfg(curve25519_dalek_bits)` to override the bits used in serial or fiat target backend.
* Restructure README and CHANGELOG * Explain semver policy * Specify feature flags and backends more explicitly * Remove nightly from the CI bc that didn't belong there * Add @pinkforest to thankyou list Co-authored-by: pinkforest <[email protected]>
README Rendered
CHANGELOG Rendered
This subsumes #443 (will add @pinkforest as coauthor). This:
nightlyfrom the CI bc that didn't belong there